Package com.cisco.pt.ipc.ui.impl
Class WebViewImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.ui.impl.WebViewImpl
Information provided by the PKI file:
\class WebView
\brief WebView allows manipulation of WebViews such as the Instruction dialog and Script Modules.
\example appWindow().getWebViewManager().getWebView("bca9d287-1eec-49a2-9bd2-ff83ef92f338")
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionWebViewImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionbooleanaddAllowedExternalFilter(String filter) Information provided by the PKI file:voidInformation provided by the PKI file:voidInformation provided by the PKI file:voidclose()Information provided by the PKI file:voidInformation provided by the PKI file:voidInformation provided by the PKI file:voidenableRightClickMenu(boolean enable) Information provided by the PKI file:voidevaluateJavaScriptAsync(String scriptSource) Information provided by the PKI file:evaluateToVariant(String scriptSource) Information provided by the PKI file:Information provided by the PKI file:longInformation provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getUrl()Information provided by the PKI file:Information provided by the PKI file:intgetWidth()Information provided by the PKI file:Information provided by the PKI file:intgetX()Information provided by the PKI file:intgetY()Information provided by the PKI file:doubleInformation provided by the PKI file:booleanhasAllowedExternalFilter(String filter) Information provided by the PKI file:voidhide()Information provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:voidInformation provided by the PKI file:voidInformation provided by the PKI file:voidInformation provided by the PKI file:voidraise()Information provided by the PKI file:booleanremoveAllowedExternalFilter(String filter) Information provided by the PKI file:voidsetBackgroundColor(long argb) Information provided by the PKI file:voidsetCanClose(boolean bCanClose) Information provided by the PKI file:voidsetDockWidgetWindowTitle(String title) Information provided by the PKI file:voidsetGeometry(int x, int y, int width, int height) Information provided by the PKI file:voidInformation provided by the PKI file:voidsetMaximumHeight(int height) Information provided by the PKI file:voidsetMaximumSize(int width, int height) Information provided by the PKI file:voidsetMaximumWidth(int width) Information provided by the PKI file:voidsetMinimumHeight(int height) Information provided by the PKI file:voidsetMinimumSize(int width, int height) Information provided by the PKI file:voidsetMinimumWidth(int width) Information provided by the PKI file:voidsetPreferredSize(int width, int height) Information provided by the PKI file:voidInformation provided by the PKI file:voidsetWindowFlags(WindowFlags flags) Information provided by the PKI file:voidsetWindowModality(WindowModality modality) Information provided by the PKI file:voidsetWindowTitle(String title) Information provided by the PKI file:voidsetZoomFactor(double factor) Information provided by the PKI file:voidshow()Information provided by the PKI file:voidInformation provided by the PKI file:voidInformation provided by the PKI file:voidInformation provided by the PKI file:voidInformation provided by the PKI file:voidInformation provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
WebViewImpl
public WebViewImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
getWebViewId
Information provided by the PKI file:
\brief Returns the UUID of this WebView. \return uuid, the UUID of this WebView.- Specified by:
getWebViewIdin interfaceWebView- Returns:
- UUID Returns a UUID
-
evaluateToVariant
Information provided by the PKI file:
\brief Evaluates the specified script. \param scriptSource, the path or source of the script. \return QString, returns the a unique string to match result from generated event.- Specified by:
evaluateToVariantin interfaceWebView- Parameters:
scriptSource- Takes in a parameter of scriptSource- Returns:
- String Returns a String
-
evaluateJavaScriptAsync
Information provided by the PKI file:
\brief Evaluates the specified script asynchronously. \param scriptSource, the path or source of the script.- Specified by:
evaluateJavaScriptAsyncin interfaceWebView- Parameters:
scriptSource- Takes in a parameter of scriptSource
-
setHtml
Information provided by the PKI file:
\brief Sets the HTML content of the WebView. \param html, the HTML content for the WebView. -
setUrl
Information provided by the PKI file:
\brief Sets the URL of the WebView. \param url, the URL for the WebView. -
getUrl
Information provided by the PKI file:
\brief Returns the URL of the current page being displayed. -
getRequestedUrl
Information provided by the PKI file:
\brief Returns the requested URL, which may be different than what getUrl() returns.- Specified by:
getRequestedUrlin interfaceWebView- Returns:
- String Returns a String
-
show
public void show()Information provided by the PKI file:
\brief Shows the WebView. -
hide
public void hide()Information provided by the PKI file:
\brief Hides the WebView. -
raise
public void raise()Information provided by the PKI file:
\brief Shows the WebView on top of other windows. -
setWindowTitle
Information provided by the PKI file:
\brief Sets the window title of the WebView. \param title, the title for the WebView.- Specified by:
setWindowTitlein interfaceWebView- Parameters:
title- Takes in a parameter of title
-
setGeometry
public void setGeometry(int x, int y, int width, int height) Information provided by the PKI file:
\brief Sets the window position and geometry of the WebView. \param x, the x-coordinate for the WebView. \param y, the y-coordinate for the WebView. \param width, the width for the WebView. \param height, the height for the WebView.- Specified by:
setGeometryin interfaceWebView- Parameters:
x- Takes in a parameter of xy- Takes in a parameter of ywidth- Takes in a parameter of widthheight- Takes in a parameter of height
-
getX
public int getX()Information provided by the PKI file:
\brief Returns the x position of the webview. -
getY
public int getY()Information provided by the PKI file:
\brief Returns the y position of the webview. -
getWidth
public int getWidth()Information provided by the PKI file:
\brief Returns the width of the webview. -
getHeight
public int getHeight()Information provided by the PKI file:
\brief Returns the height of the webview. -
setMaximumSize
public void setMaximumSize(int width, int height) Information provided by the PKI file:
\brief Sets the maximum size of the web view.- Specified by:
setMaximumSizein interfaceWebView- Parameters:
width- Takes in a parameter of widthheight- Takes in a parameter of height
-
setMaximumWidth
public void setMaximumWidth(int width) Information provided by the PKI file:
\brief Sets the maximum width of the webview.- Specified by:
setMaximumWidthin interfaceWebView- Parameters:
width- Takes in a parameter of width
-
setMaximumHeight
public void setMaximumHeight(int height) Information provided by the PKI file:
\brief Sets the maximum height of the webview.- Specified by:
setMaximumHeightin interfaceWebView- Parameters:
height- Takes in a parameter of height
-
getMaximumWidth
public int getMaximumWidth()Information provided by the PKI file:
\brief Returns the maximum width of the webview.- Specified by:
getMaximumWidthin interfaceWebView- Returns:
- int Returns a int
-
getMaximumHeight
public int getMaximumHeight()Information provided by the PKI file:
\brief Returns the maximum height of the webview.- Specified by:
getMaximumHeightin interfaceWebView- Returns:
- int Returns a int
-
setMinimumSize
public void setMinimumSize(int width, int height) Information provided by the PKI file:
\brief Sets the minimum size of the web view.- Specified by:
setMinimumSizein interfaceWebView- Parameters:
width- Takes in a parameter of widthheight- Takes in a parameter of height
-
setMinimumWidth
public void setMinimumWidth(int width) Information provided by the PKI file:
\brief Sets the minimum width of the webview.- Specified by:
setMinimumWidthin interfaceWebView- Parameters:
width- Takes in a parameter of width
-
setMinimumHeight
public void setMinimumHeight(int height) Information provided by the PKI file:
\brief Sets the minimum height of the webview.- Specified by:
setMinimumHeightin interfaceWebView- Parameters:
height- Takes in a parameter of height
-
getMinimumWidth
public int getMinimumWidth()Information provided by the PKI file:
\brief Returns the minimum width of the webview.- Specified by:
getMinimumWidthin interfaceWebView- Returns:
- int Returns a int
-
getMinimumHeight
public int getMinimumHeight()Information provided by the PKI file:
\brief Returns the minimum height of the webview.- Specified by:
getMinimumHeightin interfaceWebView- Returns:
- int Returns a int
-
setPreferredSize
public void setPreferredSize(int width, int height) Information provided by the PKI file:
\brief Sets the preferred size of the webview.- Specified by:
setPreferredSizein interfaceWebView- Parameters:
width- Takes in a parameter of widthheight- Takes in a parameter of height
-
getPreferredWidth
public int getPreferredWidth()Information provided by the PKI file:
\brief Returns the preferred width of the webview.- Specified by:
getPreferredWidthin interfaceWebView- Returns:
- int Returns a int
-
getPreferredHeight
public int getPreferredHeight()Information provided by the PKI file:
\brief Returns the preferred height of the webview.- Specified by:
getPreferredHeightin interfaceWebView- Returns:
- int Returns a int
-
isFullScreen
public void isFullScreen()Information provided by the PKI file:
\brief Returns whether the webview is shown in full screen mode.- Specified by:
isFullScreenin interfaceWebView
-
showFullScreen
public void showFullScreen()Information provided by the PKI file:
\brief Shows the webview in full-screen mode.- Specified by:
showFullScreenin interfaceWebView
-
isMaximized
public void isMaximized()Information provided by the PKI file:
\brief Returns whether the webview is maximized.- Specified by:
isMaximizedin interfaceWebView
-
showMaximized
public void showMaximized()Information provided by the PKI file:
\brief Shows the webview maximized.- Specified by:
showMaximizedin interfaceWebView
-
isMinimized
public void isMinimized()Information provided by the PKI file:
\brief Returns whether this widget is minimized (iconified).- Specified by:
isMinimizedin interfaceWebView
-
showMinimized
public void showMinimized()Information provided by the PKI file:
\brief Shows the webview minimized, as an icon.- Specified by:
showMinimizedin interfaceWebView
-
showNormal
public void showNormal()Information provided by the PKI file:
\brief Restores the widget after it has been maximized or minimized.- Specified by:
showNormalin interfaceWebView
-
setWindowFlags
Information provided by the PKI file:
\brief Sets the window flags for the WebView. \param flags, the window flags. Window flags: Widget = 0x00000000, Window = 0x00000001, Dialog = 0x00000002 | Window, Sheet = 0x00000004 | Window, Drawer = Sheet | Dialog, Popup = 0x00000008 | Window, Tool = Popup | Dialog, ToolTip = Popup | Sheet, SplashScreen = ToolTip | Dialog, Desktop = 0x00000010 | Window, SubWindow = 0x00000012, ForeignWindow = 0x00000020 | Window, CoverWindow = 0x00000040 | Window, WindowType_Mask = 0x000000ff, MSWindowsFixedSizeDialogHint = 0x00000100, MSWindowsOwnDC = 0x00000200, BypassWindowManagerHint = 0x00000400, X11BypassWindowManagerHint = BypassWindowManagerHint, FramelessWindowHint = 0x00000800, WindowTitleHint = 0x00001000, WindowSystemMenuHint = 0x00002000, WindowMinimizeButtonHint = 0x00004000, WindowMaximizeButtonHint = 0x00008000, WindowMinMaxButtonsHint = WindowMinimizeButtonHint | WindowMaximizeButtonHint, WindowContextHelpButtonHint = 0x00010000, WindowShadeButtonHint = 0x00020000, WindowStaysOnTopHint = 0x00040000, WindowTransparentForInput = 0x00080000, WindowOverridesSystemGestures = 0x00100000, WindowDoesNotAcceptFocus = 0x00200000, MaximizeUsingFullscreenGeometryHint = 0x00400000, CustomizeWindowHint = 0x02000000, WindowStaysOnBottomHint = 0x04000000, WindowCloseButtonHint = 0x08000000, MacWindowToolBarButtonHint = 0x10000000, BypassGraphicsProxyWidget = 0x20000000, NoDropShadowWindowHint = 0x40000000, WindowFullscreenButtonHint = 0x80000000, WindowOkButtonHint = 0x00080000, WindowCancelButtonHint = 0x00100000- Specified by:
setWindowFlagsin interfaceWebView- Parameters:
flags- Takes in a parameter of flags
-
getWindowFlags
Information provided by the PKI file:
\brief Returns the window flags for the WebView. See setWindowFlags() for enum values.- Specified by:
getWindowFlagsin interfaceWebView- Returns:
- WindowFlags Returns a WindowFlags
-
setWindowModality
Information provided by the PKI file:
\brief Sets the window modality for the WebView. \param modality, the window modality. Window flags: Qt::NonModal = 0, Qt::WindowModal = 1, Qt::ApplicationModal = 2,- Specified by:
setWindowModalityin interfaceWebView- Parameters:
modality- Takes in a parameter of modality
-
setCanClose
public void setCanClose(boolean bCanClose) Information provided by the PKI file:
\brief Allows or disallows closing of the WebView. \param bCanClose, true to allow closing of the WebView, false to disallow.- Specified by:
setCanClosein interfaceWebView- Parameters:
bCanClose- Takes in a parameter of bCanClose
-
addAllowedExternalFilter
Information provided by the PKI file:
\brief Adds the specified external filter from the allowed external filter list. \param filter, the filter to add. \return bool, true if successful, otherwise false. \remark Allowed external filters manages which external sites/pages are allowed to access the Script Module. Filters are wildcards and not case sensitive. \example "http:- Specified by:
addAllowedExternalFilterin interfaceWebView- Parameters:
filter- Takes in a parameter of filter- Returns:
- boolean Returns a boolean
-
removeAllowedExternalFilter
Information provided by the PKI file:
\brief Removes the specified external filter from the allowed external filter list. \param filter, the filter of interest. \return bool, true if successful, otherwise false.- Specified by:
removeAllowedExternalFilterin interfaceWebView- Parameters:
filter- Takes in a parameter of filter- Returns:
- boolean Returns a boolean
-
hasAllowedExternalFilter
Information provided by the PKI file:
\brief Returns true if the specified filter is an allowed external filter, otherwise false. \return bool, true if the specified filter is an allowed external filter, otherwise false.- Specified by:
hasAllowedExternalFilterin interfaceWebView- Parameters:
filter- Takes in a parameter of filter- Returns:
- boolean Returns a boolean
-
getAllowedExternalFilters
Information provided by the PKI file:
\brief Returns the list of allowed external filters. \return vector<QString>, the list of allowed external filters.- Specified by:
getAllowedExternalFiltersin interfaceWebView- Returns:
- List<String> Returns a List<String>
-
clearAllowedExternalFilters
public void clearAllowedExternalFilters()Information provided by the PKI file:
\brief Clears all allowed external filters.- Specified by:
clearAllowedExternalFiltersin interfaceWebView
-
close
public void close()Information provided by the PKI file:
\brief Closes the web view. -
attachToMainViewArea
public void attachToMainViewArea()Information provided by the PKI file:
\brief Attaches the web view to the main view area. It hides the web view after calling this function. Requires calling show() to show it again.- Specified by:
attachToMainViewAreain interfaceWebView
-
detachFromMainViewArea
public void detachFromMainViewArea()Information provided by the PKI file:
\brief Detaches the web view from the main view area. It hides the web view after calling this function. Requires calling show() to show it again.- Specified by:
detachFromMainViewAreain interfaceWebView
-
isAttachedToMainViewArea
public boolean isAttachedToMainViewArea()Information provided by the PKI file:
\brief Returns whether the web view is attached to the main view area.- Specified by:
isAttachedToMainViewAreain interfaceWebView- Returns:
- boolean Returns a boolean
-
dockToMainViewArea
public void dockToMainViewArea()Information provided by the PKI file:
\brief Docks the web view to the main view area. It hides the web view after calling this function. Requires calling show() to show it again.- Specified by:
dockToMainViewAreain interfaceWebView
-
undockFromMainViewArea
public void undockFromMainViewArea()Information provided by the PKI file:
\brief Undocks the web view from the main view area. It hides the web view after calling this function. Requires calling show() to show it again.- Specified by:
undockFromMainViewAreain interfaceWebView
-
isDockedToMainViewArea
public boolean isDockedToMainViewArea()Information provided by the PKI file:
\brief Returns whether the web view is docked to the main view area.- Specified by:
isDockedToMainViewAreain interfaceWebView- Returns:
- boolean Returns a boolean
-
getDockWidgetWindowTitle
Information provided by the PKI file:
\brief Returns the dock widget window title.- Specified by:
getDockWidgetWindowTitlein interfaceWebView- Returns:
- String Returns a String
-
setDockWidgetWindowTitle
Information provided by the PKI file:
\brief Sets the dock widget window title. \param title, the title to set for the dock widget window title.- Specified by:
setDockWidgetWindowTitlein interfaceWebView- Parameters:
title- Takes in a parameter of title
-
setBackgroundColor
public void setBackgroundColor(long argb) Information provided by the PKI file:
\brief Sets the background color of the web view in #AARRGGBB format. \param argb, the background color in #AARRGGBB format- Specified by:
setBackgroundColorin interfaceWebView- Parameters:
argb- Takes in a parameter of argb
-
getBackgroundColor
public long getBackgroundColor()Information provided by the PKI file:
\brief Returns the background color of the web view in #AARRGGBB format.- Specified by:
getBackgroundColorin interfaceWebView- Returns:
- long Returns a long
-
setZoomFactor
public void setZoomFactor(double factor) Information provided by the PKI file:
\brief Sets the zoom factor of this web view, ranging from 0.25 (zoomed out) to 5.0 (zoomed in), with default as 1.0. \param factor, the zoom factor- Specified by:
setZoomFactorin interfaceWebView- Parameters:
factor- Takes in a parameter of factor
-
getZoomFactor
public double getZoomFactor()Information provided by the PKI file:
\brief Returns the zoom factor of this web view, ranging from 0.25 (zoomed out) to 5.0 (zoomed in), with default as 1.0.- Specified by:
getZoomFactorin interfaceWebView- Returns:
- double Returns a double
-
enableRightClickMenu
public void enableRightClickMenu(boolean enable) Information provided by the PKI file:
\brief Enables or disables the right click context menu.- Specified by:
enableRightClickMenuin interfaceWebView- Parameters:
enable- Takes in a parameter of enable
-